check.ts ➔ classNamesCheck - Code Metrics - Inspection of "#18 Set variable to be hash XOR bool" - askirmas/react-classnaming - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 158772...7691a1 )

by Andrii

created 2021-03-03 22:31 UTC

check.ts ➔ classNamesCheck A

↳ Parent: src/check.ts

Complexity

Conditions

Size

Total Lines	10
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
dl	0
loc	10
rs	10
c	0
b	0
f	0

import { EMPTY_OBJECT } from "./consts"
import type { ReactRelated, ClassNamesFrom, CssModule, ClassHash } from "./defs"

export {
  classNamesCheck
}

//TODO On assignment
/** Checks equality
 * @example classNamesCheck<typeof App, typeof require("./module.css")>(module?) // Will return notation as array of not used classes
 * @todo On parameter:
 * @example classNamesCheck<typeof App>(require("./module.css"))
*/

/** Identical function */
function classNamesCheck<T extends CssModule>(classnames: T): T

/** Declares class keys
 * @example
 * classNamesCheck() // Anything
 * classNamesCheck<typeof Component>()
 */
function classNamesCheck(): never

/**
 * Overrides argument's shape.
 * For checking equality add `typeof css_module` as second generic parameter
*/
function classNamesCheck<K extends ReactRelated>(classnames: {[k: string]: ClassHash}): ClassNamesFrom<K>

/**
 * Check redundant keys
 */
function classNamesCheck<
  K extends ReactRelated,
  T extends ClassNamesFrom<K> = ClassNamesFrom<K> 
>(classnames?: T): string extends keyof T ? ClassNamesFrom<K>
: keyof T extends keyof ClassNamesFrom<K> ? T
// For Verbosing redundant keys
: Exclude<keyof T, keyof ClassNamesFrom<K>>[]


function classNamesCheck(classnames = EMPTY_OBJECT) {
  return classnames
}


1			import { EMPTY_OBJECT } from "./consts"
2			import type { ReactRelated, ClassNamesFrom, CssModule, ClassHash } from "./defs"
3
4			export {
5			classNamesCheck
6			}
7
8			//TODO On assignment
9			/** Checks equality
10			* @example classNamesCheck<typeof App, typeof require("./module.css")>(module?) // Will return notation as array of not used classes
11			* @todo On parameter:
12			* @example classNamesCheck<typeof App>(require("./module.css"))
13			*/
14
15			/** Identical function */
16			function classNamesCheck<T extends CssModule>(classnames: T): T
17
18			/** Declares class keys
19			* @example
20			* classNamesCheck() // Anything
21			* classNamesCheck<typeof Component>()
22			*/
23			function classNamesCheck(): never
24
25			/**
26			* Overrides argument's shape.
27			* For checking equality add `typeof css_module` as second generic parameter
28			*/
29			function classNamesCheck<K extends ReactRelated>(classnames: {[k: string]: ClassHash}): ClassNamesFrom<K>
30
31			/**
32			* Check redundant keys
33			*/
34			function classNamesCheck<
35			K extends ReactRelated,
36			T extends ClassNamesFrom<K> = ClassNamesFrom<K>
37			>(classnames?: T): string extends keyof T ? ClassNamesFrom<K>
38			: keyof T extends keyof ClassNamesFrom<K> ? T
39			// For Verbosing redundant keys
40			: Exclude<keyof T, keyof ClassNamesFrom<K>>[]
41
42
43			function classNamesCheck(classnames = EMPTY_OBJECT) {
44			return classnames
45			}
46

askirmas / react-classnaming

Push — main ( 158772...7691a1 )

check.ts ➔ classNamesCheck A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like